home *** CD-ROM | disk | FTP | other *** search
/ TarGA Party / TarGA Party.iso / pinnacle / go-menu.inf < prev    next >
Encoding:
Text File  |  1993-01-16  |  9.5 KB  |  257 lines
  1.  ╔════════════════════╗
  2.  ║                    ║
  3.  ║  WHAT IS GO-MENU?  ║
  4.  ║                    ║
  5.  ╚════════════════════╝
  6.  
  7.  
  8.   The GO-MENU program is used in a batch file to present a menu of up to 10
  9.   items.  It's ideal for:
  10.  
  11.   ■ Organizing your batch files
  12.   ■ Setting up a DOS shell (with an unlimited number of menus!)
  13.   ■ Laying out a "magazine-on-disk"
  14.   ■ Integrating your software product's various programs
  15.   ■ Arranging online documentation in a convenient way
  16.  
  17.  
  18.   The menus options can be selected by:
  19.  
  20.   ■ Arrow keys and Enter
  21.   ■ Mouse and Left Button
  22.   ■ Function key
  23.  
  24.  
  25.   GO-MENU uses DOS ERRORLEVEL (explain later) to report:
  26.  
  27.   ■ Menu option selected (1 to 10)
  28.   ■ Esc (or Mouse Right Button)
  29.  
  30.  
  31.  
  32.  ╔══════════════════════╗
  33.  ║                      ║
  34.  ║  HOW TO USE GO-MENU  ║
  35.  ║                      ║
  36.  ╚══════════════════════╝
  37.  
  38.  
  39.  ╒═══════════════╕
  40.  │  QUICK-START  │
  41.  ╘═══════════════╛
  42.  
  43.  
  44.   If you are already familiar with:
  45.  
  46.   ■ Text editors
  47.   ■ Batch files
  48.   ■ The IF ERRORLEVEL batch statement
  49.  
  50.   you can learn most of what you need to know by entering the following two
  51.   commands at the DOS prompt:
  52.  
  53.   ■ GO-MENU /?
  54.   ■ SEE START.MNU
  55.  
  56.   A more detailed explanation of GO-MENU follows.
  57.  
  58.  
  59.  
  60.  ╒════════════════════════════╕
  61.  │  THE MENU DEFINITION FILE  │
  62.  ╘════════════════════════════╛
  63.  
  64.  
  65.   GO-MENU reads the contents of the menu from an ordinary text file that you
  66.   have prepared with a text editor (e.g. DOS's EDLIN or EDIT, or a programmer's
  67.   editor, or a word processor in "DOS Text" mode).  The text file contains
  68.   eleven lines, corresponding to:
  69.  
  70.   ■ The menu title
  71.   ■ The F1, F2, F3 ... F10 lines on the menu.
  72.  
  73.   The basic DOS command line format for GO-MENU is:
  74.  
  75.   GO-MENU <menu file>
  76.  
  77.   For example, at the DOS prompt, you could enter the command as:
  78.  
  79.   GO-MENU START.MNU
  80.  
  81.   The file START.MNU (included with "The SEE Utilities") contains the menu
  82.   for the batch file START.BAT.  It shows also how lines beginning with a
  83.   semi-colon (;) are ignored as comments.  To view START.MNU, enter the
  84.   following command at the DOS prompt:
  85.  
  86.   SEE START.MNU
  87.  
  88.   The menu file does not have to have a MNU extension, but for the sake of
  89.   clarity, it is a good idea to give all your menus the same extension.
  90.  
  91.   If you have less than 10 items on your menu, you can leave some lines blank.
  92.   These lines will then be left blank on the menu when it is displayed.
  93.  
  94.   NOTE:  If there are more than one blank line in a row, only one blank line
  95.   will be shown.  For example, if you had a menu definition file like this:
  96.  
  97.   ┌───────────────────────────┐
  98.   │; This is a comment line   │ <-- Comment line (not displayed)
  99.   │My Sample Menu             │ <-- Menu title
  100.   │This is the 1st menu line  │ <-- Corresponds to F 1 key
  101.   │                           │ <-- Blank line to skip F 2 key
  102.   │This is the 3rd menu line  │ <-- Corresponds to F 3 key
  103.   │                           │ <-- Blank line to skip F 4 key
  104.   │                           │ <-- Blank line to skip F 5 key
  105.   │This is the 6th menu line  │ <-- For F 6 key
  106.   │                           │ <-- Blank line to skip F 7 key
  107.   │This is the 8th menu line  │ <-- For F 8 key
  108.   │This is the 9th menu line  │ <-- For F 9 key
  109.   │This is the 10th menu line │ <-- For F10 key (should be used for Quit)
  110.   └───────────────────────────┘
  111.  
  112.   there would only be ONE blank line between F3 and F6, even though both F4
  113.   and F5 have been left blank.  This results in a more attractive menu.
  114.  
  115.   The menu file shown above has been included with "The SEE Utilities".  If
  116.   you would like to try it out, enter the following command at the DOS prompt:
  117.  
  118.   GO-MENU MYMENU.MNU
  119.  
  120.   If you want to look at the menu definition file MYMENU.MNU, enter this
  121.   command at the DOS prompt:
  122.  
  123.   SEE MYMENU.MNU
  124.  
  125.   For reasons that will be explained later, it is best to define the F10 key
  126.   as "Quit" (i.e. return to previous menu or operation).
  127.  
  128.   When GO-MENU is looking for a menu file, it will look in the CURRENT drive
  129.   and directory first.  If it can not find it there, it will look in the
  130.   directory that GO-MENU.EXE itself is in.  You can override this behaviour by
  131.   specifying the full DOS path name to the file. (e.g. C:\MYMENUS\MENUX.MNU)
  132.  
  133.  
  134.  
  135.  ╒══════════════════╕
  136.  │  THE BATCH FILE  │
  137.  ╘══════════════════╛
  138.  
  139.  
  140.   GO-MENU controls a batch file by setting the DOS ERRORLEVEL.  (For complete
  141.   information about coding batch files, you can refer to your DOS manual,
  142.   though there is enough information given here to code batch files that use
  143.   GO-MENU.)
  144.  
  145.   A batch file is an ordinary text file that you have prepared with a text
  146.   editor (e.g. DOS's EDLIN or EDIT, or a programmer's editor, or a word
  147.   processor in "DOS Text" mode).  A batch file MUST have a BAT extension for
  148.   DOS to recognize it.  Thus, the name MYBATCH.BAT is a valid batch file name,
  149.   while MYBATCH.TXT is not.
  150.  
  151.   Let us say you are using the menu definition file MYMENU.MNU (described in
  152.   the previous section).  You would code your batch file like this:
  153.  
  154.   ┌─────────────────────────────────────┐
  155.   │ECHO OFF                             │ <-- Don't echo commands
  156.   │:AGAIN                               │ <-- A batch label (used by GOTO)
  157.   │GO-MENU MYMENU.MNU                   │ <-- Call the GO-MENU program
  158.   │IF ERRORLEVEL 10 GOTO QUIT           │ <-- Check for F10 key
  159.   │IF ERRORLEVEL  9 GOTO F9             │ <-- Check for F 9 key
  160.   │IF ERRORLEVEL  8 GOTO F8             │ <-- Check for F 8 key
  161.   │IF ERRORLEVEL  6 GOTO F6             │ <-- Check for F 6 key
  162.   │IF ERRORLEVEL  3 GOTO F3             │ <-- Check for F 3 key
  163.   │IF ERRORLEVEL  1 GOTO F1             │ <-- Check for F 1 key
  164.   │:F9                                  │ <-- A batch label (used by GOTO)
  165.   │ECHO That was F9                     │ <-- Displays the text on the screen
  166.   │GOTO WAIT                            │ <-- Jumps ahead to the :WAIT label
  167.   │  ■                                  │
  168.   │  ■────Similar code for F8, F6, etc. │
  169.   │  ■                                  │
  170.   │:WAIT                                │ <-- A batch label (used by GOTO)
  171.   │PAUSE                                │ <-- Waits for user to press a key
  172.   │GOTO AGAIN                           │ <-- Jumps back to the :AGAIN label
  173.   │:QUIT                                │ <-- A batch label (used by GOTO)
  174.   └─────────────────────────────────────┘
  175.  
  176.   The complete batch file shown above is included with "The SEE Utilities".
  177.   It is named MYMENU.BAT.  To try it out, enter the following command at the
  178.   DOS prompt:
  179.  
  180.   MYMENU
  181.  
  182.   ▒▒▒ IMPORTANT NOTE:  When you write your batch file, you must be sure
  183.   ▒█▒ to test the highest ERRORLEVELs first, because IF ERRORLEVEL is
  184.   ▒▒▒ considered "TRUE" if the ERRORLEVEL is the indicated number OR HIGHER.
  185.  
  186.  
  187.  
  188.  ╒════════════════╕
  189.  │  STICKY MENUS  │
  190.  ╘════════════════╛
  191.  
  192.  
  193.   If you tried out the MYMENU.BAT file (described in the last section), you
  194.   probably noticed that after each selection, the selection bar returned to
  195.   the first item.  This is fine for simple applications, but if you have a lot
  196.   of menus, it would be nice to have it remember which item you selected on
  197.   each menu.
  198.  
  199.   GO-MENU can create a "save" file that remembers where each menu is pointed.
  200.   To create a save file, start up GO-MENU with this command format:
  201.  
  202.   GO-MENU <menu file name> <save number> <save file name>
  203.  
  204.   For example, to use the menu file MYMENU.MNU and save the menu position as
  205.   "Menu Number 1" in the save file MENU.SAV, you would enter the command this
  206.   way:
  207.  
  208.   GO-MENU MYMENU.MNU 1 MENU.SAV
  209.  
  210.   After you've done that, every time you call up GO-MENU with that command
  211.   line, it will remember which option was last selected on the menu MYMENU.MNU.
  212.  
  213.   A sample batch file that uses this technique can be found in MENUSAVE.BAT.
  214.   To try it out, enter the following command at the DOS prompt:
  215.  
  216.   MENUSAVE
  217.  
  218.   ▒▒▒ IMPORTANT NOTE:  When you save a menu position, you are writing to the
  219.   ▒█▒ disk.  For this reason, a save file will not work properly if it is
  220.   ▒▒▒ used on a diskette that is write-protected.
  221.  
  222.   The save procedure will save any selection EXCEPT F10.  This is because F10
  223.   is reserved, by GO-MENU, for "Quit".  (If "Quit" was saved, most of the
  224.   menus you save would remember that as the last option selected!)
  225.  
  226.   A save file can save up to 256 menus, numbered from 0 to 255.  If you need
  227.   more menus than that, you can use a different save file.  It helps to keep
  228.   track of the save numbers you have used by noting them in comment lines in
  229.   the main menu.  (For an example of this, SEE the file START.MNU)
  230.  
  231.   ▒▒▒ IMPORTANT NOTE:  Remember that the save file is CREATED the first time
  232.   ▒█▒ it is used.  If you are putting GO-MENU on a diskette, it's a good idea
  233.   ▒▒▒ to create the save file ahead of time, so you don't run out of space.
  234.  
  235.   When GO-MENU is looking for a menu file, it will look in the CURRENT drive
  236.   and directory first.  You can override this behaviour by specifying the full
  237.   DOS path name to the file. (e.g. C:\MYMENUS\MENUX.SAV)
  238.  
  239.  
  240.  
  241.  ╔═══════════════════════╗
  242.  ║                       ║
  243.  ║  MISCELLANEOUS NOTES  ║
  244.  ║                       ║
  245.  ╚═══════════════════════╝
  246.  
  247.  
  248.   For a quick summary of the material covered above, try starting GO-MENU by
  249.   typing the following command at the DOS prompt:
  250.  
  251.   GO-MENU /?
  252.  
  253.   If you would like to see a major application that uses GO-MENU and SEE for
  254.   integration, we recommend that you obtain an evaluation copy of the Sapphire
  255.   BBS software from us.  See the file AMAZE.DOC for details.
  256.  
  257.